Tangoe Mobile REST API

(0 reviews)

Attribute Mapping

/activities (Show a list of Activities) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response.	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
created_id_eq	The Carrier ID by which to filter Activities.	FALSE		DATE
created_at_gt	Date by which to filter Activities created after (e.g. '2014-06-07')	FALSE		DATE
created_at_lt	Date by which to filter Activities created before (e.g. '2014-06-07')	FALSE		DATE
created_at_gte	Date by which to filter Activities created after or on (e.g. '2014-06-07')	FALSE		DATE
created_at_lte	Date by which to filter Activities created before or on (e.g. '2014-06-07')	FALSE		DATE
completed_at_gt	Date by which to filter Activities completed after (e.g. '2014-06-07')	FALSE		DATE
completed_at_lt	Date by which to filter Activities completed before (e.g. '2014-06-07')	FALSE		DATE
completed_at_gte	Date by which to filter Activities completed after or on (e.g. '2014-06-07')	FALSE		DATE
completed_at_lte	Date by which to filter Activities completed before or on (e.g. '2014-06-07')	FALSE		DATE
updated_at_gt	Date by which to filter Activities updated after (e.g. '2014-06-07')	FALSE		DATE
updated_at_lt	Date by which to filter Activities updated before (e.g. '2014-06-07')	FALSE		DATE
updated_at_gte	Date by which to filter Activities updated after or on (e.g. '2014-06-07')	FALSE		DATE
updated_at_lte	Date by which to filter Activities updated before or on (e.g. '2014-06-07')	FALSE		DATE
activity_type_id_eq	The Activity Type ID by which to filter Activities.	FALSE		INT
state_eq	The current state by which to filter Activities	FALSE		STR
assigned_to_id_eq	The currently assigned person_id to the activity.	FALSE		STR
rpa_attempted_eq	Filter activities by rpa_attempted_eq (true/false).	FALSE		BOOLEAN
sleeping	Filter Activities that are 'sleeping'	FALSE		BOOLEAN
not_sleeping	Filter Activities that are not 'sleeping'	FALSE		BOOLEAN
order	A comma-separated list of custom orderings for returned Activities. Follows the format "column:direction", e.g. "state:asc,updated_at:desc".	FALSE		STR

/activities/preview\_price (This takes the same inputs as the "Create a new Activity" endpoint but returns One Time and Recurring costs instead) - POST

ATTRIBUTES	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
Varies by activity type
200 RESPONSE
one\_time\_cost	Shows one-time cost of all info such as the device, plan, features, and accessories…
recurring\_cost	Shows recurring monthly cost
442 RESPONSE
error	Type of error
error\_description	Description of the error
message	Message
preferred\_city	Can't be blank
shipping\_address	Is invalid
shipping\_address.address1	Can't be blank

/activities/validate\_price (This takes the same inputs as the "Create a new Activity" endpoint and only returns validation information) - POST

ATTRIBUTES	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
Varies by activity type
200 RESPONSE
valid	Validating if code is correct

/activities/{ID} (Show a single activity) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
id	The ID of the activity	TRUE	N/A	STR
200 RESPONSE same as activities.
404 RESPONSE
error	Type of error			STR
error\_description	Description of the error			STR

/accessories (Show a list of configured accessories for a business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
business_ref_device_id	Filter Accessories by compatible Business Ref Device	FALSE		INT	/business_ref_device_id
200 RESPONSE
id	Unique identifier for the accessory			INT
sku	Number assigned to a accessory			INT
date_added	Date added			INT
short_description	Title of accessory			INT
detail	Description of accessory			STR
msrp	The manufacturer's suggested retail price for this accessory.			STR
manufacturer	The company who manufactures this accessory.			STR
color	The color of this device, as specified by the manufacturer.			STR
remote_id	The vendor's unique identifier for this accessory.			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
category	Accessory Catalog			STR
active	Indicates if the person is active			BOOLEAN
currency	What currency, USD, AUD, Euro…			STR
price_points	The current price for this accessory.			STR
serialized	Yes or No if it has a serial #			BOOLEAN
admin_only	Access for admin only			STR
quantity_on_hand	Overall quantity			STR
image_url	Accessory image			STR
vendor	The vendor who offers this accessory.
id	ID number of the vendor
name	person name
help_desk_phone	help desk phone #
tangoe_support_email	Tangoe email address
subdomain	subdomain of the business in Tangoe mobile
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/accessories/{ID} (The ID of a single accessory) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	The id of a single accessory	TRUE	STR (string)
200 RESPONSE same as accessories.
404 RESPONSE
error	Type of error		STR
error\_description	Description of the error		STR

/approvals (Show all visible approvals for the current person) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
employee_id	employee id of the person the bulletins are for	FALSE		STR
200 RESPONSE
id	The ID of the approval.			INT
state	State of where the line is being approved			INT
comments	Any comments related to the approval.			STR
created_at	Date Created			DATE
expires_at	Date Expires			DATE
days_until_expiration	Days left until expiration			DATE
approval_details
detail_text	Text description			STR
request_details_url	The URL to request details.			STR
approve_approval_url	The URL to approve the approval.			STR
deny_approval_url	The URL to deny the approval.			STR
approvable
approvable_id	The type of approvable ID #			INT
approvable_type	The approvable type			STR
activity
id	Activity ID #			INT
created_for_id	Person Activity For			INT
created_by_id	Person creating Activity			INT
line_id	The ID of the line of service for which the request is being made.			INT
completed_at	Date Completed			DATE
shipping_address_id	Shipping Address			STR
carrier_account	Carrier Account			INT
preferred_area_code	Preferred area code of device location			STR
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business			INT
preferred_calling_prefix	Preferred calling prefix of device location		"3 Characters xxx-123-xxxx"	STR
state	State of where the line is being activated		2 letter abbreviation	STR
business_id	ID number of Business			INT
new_sim	New ICCID/SIM Card for the wireless device on this line			STR
assigned_to_id	Account Specialist			INT
created_at	Date Created			DATE
updated_at	Last Updated			DATE
comment	Comment entered when this activity was created			STR
return_date	Date device was returned			DATE
pick_up_date	Date of device pick up			DATE
warranty	Warranty of device			STR
plan_id	ID of the mobile carrier plan			INT
carrier_id	ID of the mobile carrier			INT
activity_type_id	The type of activity ID number			INT
new_imei	The unique serial number for the wireless device on this line, often found in the device's settings menu or printed on the device itself			INT
sleep_until	Sleep Activity Until Date			DATE
label	Carrier Label			STR
parent_activity_id	Parent Activity ID			INT
lockbox_token	Lockbox Token			INT
device_id	ID of the device			INT
replacement_ref_device_id	Replacement Device ID			INT
existing_ref_device_id	Existing Ref Device ID			INT
replacement_person_id	Replacement Person ID			INT
existing_person_id	Existing Person ID			INT
replacement_plan_id	Replacement Plan ID			INT
existing_plan_id	Existing Plan ID			INT
lost_stolen	Lost or Stolen			BOOLEAN
currency	What currency, USD, AUD, Euro…			STR
plan_cost_cents	Plan Cost in cents			STR
device_cost_cents	Device Cost in cents			STR
approved_at	Approved at			STR
shipping_method	Shipping Method			STR
triggered_by_activity_id	Triggered by activity			INT
rpa_attempted	Filter activities by rpa_attempted (true/false)			BOOLEAN
original_carrier_account_id	Original Carrier Account ID			INT
activity_type
name	Activity Name			STR
approval_processor
id	ID number of person processing approval			INT
state	State in which approval is being processed			STR
processor_setting	The Approval Processor Setting the Approval Setting belongs to			STR
name	Name of processor			STR
basic_title	Basic title of processor			STR
created_for
id	ID number of person created for			INT
name_last	Last name			STR
name_first	First name			STR
name_middle	Middle name			STR
group_id	ID number of the group			INT
email	Email of employee created for			STR
login	Login of employee created for			STR
employee_id	ID of employee created for			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
cost_center	Cost Center			STR
active	Indicates if the person is active			BOOLEAN
customer_data	Customer data			STR
person
id	ID number of person created for			INT
name_last	Last name			STR
name_first	First name			STR
name_middle	Middle name			STR
email	Email of employee created for			INT
login	Login of employee created for			STR
employee_id	ID of employee created for			STR
created_at	Date created			INT
updated_at	Date updated			DATE
cost_center	Cost Center			DATE
active	Indicates if the person is active			BOOLEAN
customer_data	Customer data			BOOLEAN
group_name	Name of group			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/approvals/{ID}/approve (Approve an Approval) - POST

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	The ID of the approval	TRUE	INT
ATTRIBUTE NAME
comments	Any comments related to the approval	TRUE	STR
200 RESPONSE Same as accessories

/approvals/{ID}/deny (Deny an Approval) - POST

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	The ID of the approval	TRUE	INT
ATTRIBUTE NAME
comments	Any comments related to the approval	TRUE	STR

/approvals/{ID} (Show a single Approval) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	The id of the approval	TRUE	INT
404 RESPONSE
error	Type of error		STR
error\_description	Description of the error		STR

/bulletins (Show all of the visible bulletins for the current person) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
employee_id	employee id of the person the bulletins are for	FALSE		STR
200 RESPONSE
id	Unique identifier for the bulletin			INT
parameters	Indicates the urgency level of a bulletin			STR
urgency	Priority			STR
created_at	Date created			DATE
updated_at	Date updated			DATE
bulletin_details	Info about bulletin			STR
bulletin_type	Type of activity bulletin was created for			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/bulletins/{ID}/dismiss (Dismiss a bulletin) - PATCH

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	The ID of the Bulletin	TRUE	INT
200 RESPONSE
message	Message response from the initial query		STR

/business\_features (In Tangoe Mobile, a BusinessFeature is a Feature (messaging, data, etc.) associated with a Business filtered by the parameters provided) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
activity_type_id	The type of activity ID number	FALSE		INT
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.	FALSE		INT
carrier_id	The id of the Mobile Carrier	FALSE		INT
country_id	country of where the service is being activated	FALSE		INT
business_plan_id	A BusinessPlan is a Carrier's Plan associated with a Business	FALSE		INT
line_id	The ID of the line of service for which the request is being made.	FALSE		INT
business_ref_device_id	Filter Accessories by compatible Business Ref Device	FALSE		INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business	FALSE		INT
person_id	The ID of the person this line is assigned to in the portal	FALSE		INT
200 RESPONSE
id	ID number of person the feature is for			INT
feature_id	Feature ID number			INT
note	Notes			STR
cost_cents	Cost in cents			STR
currency	What currency, USD, AUD, Euro…			STR
name	Feature name			STR
description	Description of the feature			STR
cost_to_currency	Shows the cost in the selected currency			STR
category	Category the particular feature falls under			STR
name_and_cost	Feature name and cost			STR
name_override	Change the feature name			STR

count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/business\_features /features\_to\_add (Dismiss a bulletin) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
activity_type_id	The type of activity	TRUE		INT
line_id	The ID of the line of service for which the request is being made.	TRUE		INT
200 RESPONSE
id	ID number of person the accessory is for			INT
feature_id	Feature id number			INT
note	Notes			STR
cost_cents	Cost in cents			STR
currency	What currency, USD, AUD, Euro…			STR
name	Feature name			STR
description	Description of the feature			STR
cost_to_currency	Shows the cost in the selected currency			STR
category	Category the particular feature falls under			STR
name_and_cost	Feature name and cost			STR

/business\_plan (In Tangoe Mobile, a BusinessPlan is a Carrier's Plan associated with a Business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
activity_device_id	The type of activity ID number	FALSE		INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business	FALSE		INT
activity_type_id	The type of activity id number	FALSE		INT
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.	FALSE		STR
carrier_account_id	carrier_account_id	FALSE		INT
business_ref_device_id	Filter Accessories by compatible Business Ref Device	FALSE		INT
line_id	The ID of the line of service for which the request is being made.	FALSE		INT
person_id	The ID of the person this line is assigned to in the portal	FALSE		INT
200 RESPONSE
id	Unique Identifier for the plan			INT
plan_id	Plan id			INT
currency	What currency, USD, AUD, Euro…			STR
cost_cents	Cost in cents			STR
full_name	Plan name			STR
description	Plan description			STR
cost_to_currency	Shows the cost in the selected currency			STR
full_description	Full description of the carrier plan			STR
name_and_cost	Feature name and cost			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

400 RESPONSE
error	Type of error
error_description	Description of the error

/business\_ref\_devices (A specific kind of Device list (phone/aircard/tablet/etc.) associated with a Business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
activity_type_id	The type of activity id number	FALSE		INT
carrier_id	The id of the Mobile Carrier.	FALSE		INT
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.	FALSE		STR
person_id	The ID of the person this line is assigned to in the portal	FALSE		INT
business_plan_id	A BusinessPlan is a Carrier's Plan associated with a Business	FALSE		INT
line_id	The ID of the line of service for which the request is being made.	FALSE		INT
carrier_account_id	Carrier Account	FALSE		INT
current_device_category	Category of current device	FALSE		STR
device_id	ID of the device	FALSE		IND
200 RESPONSE
id	Unique id number for devices			INT
business_id	Business id			INT
ref_device_id	Device Model Ordered			INT
created_at	Date created			STR
updated_at	Date updated			STR
notes	Notes			STR
name_override	Change of Name			STR
business_carrier_id	ID of the carrier			INT
full_name	Device full name			STR
description	Device description			STR
manufacturer	Manufacturer of the device			STR
platform	The platform the ref device uses			STR
product_category	The type of device (ie. phone, tablet, etc.)			STR
device_programming_instructions	Programming instructions			STR
image_url	URL to the Image of device			STR
lowest_available_cost_cents	Lowest cost in cents			INT
lowest_available_currency	Lowest cost in correct currency			INT
name_and_cost	Device name and cost			STR
no_commitment_cost_cents	No commitment cost in cents			INT
no_commitment_cost_currency	No commitment cost correct currency			STR
carrier
id	carrier id #			INT
name	carrier name			STR
img_url	URL to the image of carrier			STR
price_points
id	Unique id for the price points			INT
name	Name of the price points			STR
price
fractional	Price			STR
currency
id	Unique id for the currency			INT
alternate_symbols	Array of alternate symbols for the Currency			ArrayType
decimal_mark	Decimal mark			STR
disambiguate_symbol	Disambiguate symbol			STR
html_entity	HTML entities			STR
iso_code	ISO Code			STR
iso_numeric	ISO Numeric			STR
name	Name of business			STR
priority	Priority			INT
smallest_denomination	Smallest Denomination			INT
subunity_to_unit	Subunity to unit			INT
symbol	Symbol			STR
symbol_first	Indicates if the symbol comes before the amount			BOOLEAN
thousands_separator	Thousands separator			STR
service_agreement	Service Agreement			INT
code	Code			INT
priceable_id	Unique id for the priceable			INT
priceable_type	The priceable type			STR
created_at	Date created			DATE
updated_at	Date updated			DATE
currency	Currency being used			STR
price_cents	Price in cents			INT
monthly_price_cents	Monthly price in cents			INT
price_rules
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/business\_ref\_devices/{id} (Show a single BusinessRefDevice, found by its id) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
id	The unique id for the device of that business	TRUE	N/A	INT
200 RESPONSE
id	The unique id for the device			INT
business_id	Business id			INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business		N/A	INT
created_at	Date created			STR
updated_at	Date updated			STR
notes	Notes			STR
name_override	Change of Name			STR
full_name	Device name			STR
description	Device description			STR
manufacturer	Manufacturer of the device			STR
manufacturer_sku	Number assigned to a device by manufacturer			INT
platform	The platform the ref device uses			STR
product_category	Category for device			STR
device_programming_instructions	Programming instructions			STR
image_url	Image of device			STR
lowest_available_cost_cents	Lowest cost in cents			STR
lowest_available_currency	Lowest cost in correct currency			STR
name_and_cost	Device name and cost			STR

/business\_ref\_devices/{ref\_device\_id}/show\_by\_ref\_device\_id (Show a single BusinessRefDevice, found by its ref\_device\_id) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business	TRUE	INT
200 RESPONSE
Same as business_ref_devices_id

/business\_ref\_devices/catalog (Show the entire business ref device catalog for a business.) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
carrier_id	The id of the Mobile Carrier	FALSE	INT
200 RESPONSE
Same as business_ref_devices

/calls (Calls capture the interaction between a support specialist and a live customer) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.	FALSE		INT
created_before	Date by which to filter Calls created before	FALSE		DATE
created_after	Date by which to filter Calls created after	FALSE		DATE
updated_before	Date by which to filter Calls updated before	FALSE		DATE
updated_after	Date by which to filter Calls updated after	FALSE		DATE
resolved	Filter Calls by resolution (true/false)	FALSE		STR
200 RESPONSE
id	The ID of the call			INT
call_type	Type of call			INT
caller_name	Name of caller			DATE
caller_number	Number of caller			STR
on_behalf_of_id	Assistant assigned to caller			STR
recipient_id	The person who received the call			INT
line_id	The ID of the line of service for which the request is being made.			STR
activity_id	Activity for caller			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
business_id	Business associated with line			INT
resolved	Indicates if the reason for the call was resolved			BOOLEAN
portal_notes	Notes			STR
assigned_to_id	The operator the call is assigned to			INT
resolved_at	The datetime when the call was resolved			DATE
survey_remote_result_id	The ID of the survey that was completed for the call			INT
number_call_is_about	The phone number of the device the call is about			STR
device_type	The type of device the call is about			STR
vip	VIP			BOOLEAN
line_carrier_id	The ID of the carrier			INT
on_behalf_of_cost_center	The cost center of the person the call was made on behalf of			STR
on_behalf_of_group_id	The group of the person the call was made on behalf of			STR
call_answered_at	The datetime when the call was answered			DATE
entered_workgroup_at	Entered Workgroup At			DATE
connected_at	The datetime when the call was connected to an operator			DATE
discounted_at	The time when the call disconnected			DATE
event_log	Event Log			STR
hold_time	Hold Time			INT
talk_time	The amount of time the call remained active			INT
handle_time	Handle Time			INT
direction	The direction of the call			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/calls/{ID} (Calls capture the interaction between a support specialist and a live customer) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	Unique Identifier for the call	TRUE	STR (string)
200 RESPONSE
same as call response

/carriers (A list of carriers, optionally filtered by person\_id or employee\_id) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.	FALSE		INT
person_id	The ID of the person this line is assigned to in the portal	FALSE		INT
200 RESPONSE
id	id number of carrier			INT
name	carrier name			STR
image_url	image of carrier logo			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/devices (Show all the devices for the requester's business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
employee_id	The employee_id of the person the device is for; either person_id or employee_id is required.	FALSE		INT(integer)
person_id	The ID of the person this line is assigned to in the portal	FALSE		INT
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT
page	Shows the number of pages	FALSE		INT
200 RESPONSE
id	The ID of the device			INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business			INT
business_id	The ID of the business the device belongs to			DATE
esn	Electronic serial number for the device			STR
meid	Mobile Equipment Identifier for the device			STR
imei	International mobile equipment identity for the device			INT
msn	The mobile serial number of the device			STR
status	Status of Device			STR
created_at	Date created			DATE
updated_at	Date updated			DATE
managed	Indicates if the carrier account is managed			STR
person_id	The ID of the person this line is assigned to in the portal			INT
generic_serial	The generic serial of the device			STR
warehouse_status	The status of the device according to the warehouse			STR
full_device_profile
device_url	Device subdomain			STR
ref_device	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business
id	Device id #			INT
name	Device Name			STR
description	Description of device			STR
image_file_name	Device image file name			INT
sku	The generic SKU of the ref device			STR
color	Device Color			STR
platform	The platform the ref device uses			STR
product_category	The type of device (ie. phone, tablet, etc.)			STR
manufacturer	Maker of the ref device			STR
consumer_sku	The consumer SKU of the ref device			STR
size	The storage size of the ref device			STR
carrier_name	Name of carrier for the ref device			INT
supplier_sku	The supplier SKU of the ref device			INT
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/devices (Create a device) - PUSH

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
status	Show a single Accessory	FALSE	STR (string)
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business	FALSE	INT
identifier	Device identifier (IMEI, MEID, ESN, MSN, Generic Serial).	FALSE	STR
person_id	The ID of the person this line is assigned to in the portal	FALSE	INT
warehouse_status	The status of the device according to the warehouse	FALSE	STR
external_id	Device External ID	FALSE	INT
200 RESPONSE
id	The ID of the device		INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business		INT
business_id	The ID of the business the device belongs to		DATE
esn	electronic serial number for the device		STR
meid	Mobile Equipment Identifier for the device		STR
imei	International mobile equipment identity for the device		INT
msn	The mobile serial number of the device		STR
status	Status of Device		STR
created_at	Date created		DATE
updated_at	Date updated		DATE
managed	Indicates if the carrier account is managed		STR
person_id	The ID of the person this line is assigned to in the portal		INT
generic_serial	The generic serial of the device		STR
warehouse_status	The status of the device according to the warehouse		STR
full_device_profile
device_url	device subdomain		STR
line_id	The ID of the line of service for which the request is being made.		INT
ref_device	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business
id	Device id #		INT
name	Device Name		STR
description	Description of device		STR
image_file_name	Device image file name		INT
sku	The generic SKU of the ref device		STR
color	Device Color		STR
platform	The platform the ref device uses (apple, android…)		STR
product_category	Cell Phone, tablet…		STR
manufacturer	Maker of the ref device		STR
consumer_sku	The consumer SKU of the ref device		STR
size	The storage size of the ref device		STR
carrier_name	Name of carrier for the ref device		INT
supplier_sku	The supplier SKU of the ref device		INT
person
id	id number of person created for		INT
name_last	Last name		STR
name_first	First name		STR
name_middle	Middle name		STR
email	Email of employee created for		STR
login	Login of employee created for		STR
employee_id	id of employee created for		INT
created_at	Date created		DATE
updated_at	Date updated		DATE
cost_center	Cost Center		STR
active	Indicates if the person is active		BOOLEAN
customer_data	Customer data		INT
group_name	Name of group		STR
count	Number of accessories
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of accessories listed on current page
count	Number of accessories
pages	Number of pages in total

/devices/business\_devices (Show all the devices for the requester's business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
updated_at_gt	Date by which to filter Support Requests updated after (e.g. '2014-06-07')	FALSE	DATE
updated_at_lt	Date by which to filter Support Requests updated before (e.g. '2014-06-07')	FALSE	DATE
updated_at_gte	Date by which to filter Support Requests updated after or on (e.g. '2014-06-07')	FALSE	DATE
updated_at_lte	Date by which to filter Support Requests updated before or on (e.g. '2014-06-07')	FALSE	DATE
managed_eq	Filter devices by the managed flag	FALSE	BOOLEAN
200 RESPONSE
id	The ID of the device		INT
line_id	The ID of the line of service for which the request is being made.		INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business		INT
business_id	The ID of the business the device belongs to		DATE
created_at	Date created		DATE
updated_at	Date updated		DATE
managed	Indicates if the carrier account is managed		STR
full_device_profile
device_url	device subdomain		STR
ref_device	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business
id	Device id #		INT
name	Device Name		STR
description	Description of device		STR
image_file_name	Device image file name		INT
model
id	the model id #		STR
name	Name of the model		STR
weight	The weight of the ref_device		STR
dimensions	Maker of the ref_device		STR
battery	The consumer SKU of the ref device		STR
to_s	The storage size of the ref_device		STR
image_path_medium	Name of carrier for the ref_device		INT
category	The supplier SKU of the ref_device		INT
i18n_category	Language category
price_points	Various price points for the device based on carrier
count	Number of accessories
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of accessories listed on current page
count	Number of accessories
pages	Number of pages in total

/devices/search (Search for a device by device identifiers) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
identifier	Device identifier (IMEI, MEID, ESN, MSN, Generic Serial).	TRUE	DATE
200 RESPONSE
id	The ID of the device		INT
ref_device_id	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business		INT
business_id	The ID of the business the device belongs to		DATE
esn	electronic serial number for the device		STR
meid	Mobile Equipment Identifier for the device		STR
imei	International mobile equipment identity for the device		INT
msn	The mobile serial number of the device		STR
status	Status of Device		STR
created_at	Date created		DATE
updated_at	Date updated		DATE
managed	Indicates if the carrier account is managed		STR
person_id	The ID of the person this line is assigned to in the portal		INT
generic_serial	The generic serial of the device		STR
warehouse_status	The status of the device according to the warehouse		STR
full_device_profile
device_url	Device subdomain		STR
line_id	The ID of the line of service for which the request is being made.		INT
ref_device	Specific kind of Device (phone/aircard/tablet/etc.) associated with a Business
id	Device id #		INT
name	Device Name		STR
description	Description of device		STR
image_file_name	Device image file name		INT
sku	The generic SKU of the ref device		STR
color	Device Color		STR
platform	The platform the ref device uses (apple, android…)		STR
product_category	Cell Phone, tablet…		STR
manufacturer	Maker of the ref device		STR
consumer_sku	The consumer SKU of the ref device		STR
size	The storage size of the ref device		STR
carrier_name	Name of carrier for the ref device		INT
supplier_sku	The supplier SKU of the ref device		INT

/devices/{ID} (Search for a device by device identifiers) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
identifier	Device identifier (IMEI, MEID, ESN, MSN, Generic Serial).	TRUE		STR

/features (Features will be filtered by only one parameter, must provide one parameter) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
line_id	The ID of the line of service for which the request is being made.	FALSE		INT
plan_id	ID of the mobile carrier plan	FALSE		INT
carrier_id	Id of the mobile carrier	FALSE		INT
carrier_account_id	Carrier account id	FALSE		INT
200 RESPONSE
id	Unique identifier of the feature			INT
name	Name of the feature			STR
description	Description of the feature			STR
carrier_id	Carrier id for this feature			INT
active	Indicates if the feature is active			BOOLEAN
note	Notes			INT
selectable	Determines whether or not this feature is selectable via the platform interface			STR
cost_cents	Cost in cents			STR
currency	The three letter currency code of the currency used for the activity			STR
remote_catalog_asset
id	Unique identifier of the catalog asset			INT
supplier_part_number	The supplier part number of the remote asset			STR
type	Type of assest			STR
description	description of the catalog asset			INT
orderable	Indicates if the remote catalog asset is orderable			BOOLEAN
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/interactions (Create an interaction) - POST

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
interaction_thread_token	The token of the interaction thread that the interaction should be added to.	TRUE	STR
text	The text content of the interaction.	TRUE	STR
person_id	The ID of the person this line is assigned to in the portal	TRUE	INT
200 RESPONSE
id	The ID of the person making the interaction		INT
text	The text content of the interaction.		STR

/lines (Show all the lines for a person and the line's associated activities) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
employee_id	The employee id of the person	FALSE		STR
200 RESPONSE
id	The portal unique identifier for this line			INT
active	Indicates if the carrier account is active			BOOLEAN
business_id	Business associated with the line			DATE
contract_ends	The date when the line of service can be canceled with no penalties from the carrier			STR
carrier_account_id	Carrier Account Number			STR
person_id	The ID of the person this line is assigned to in the portal			INT
suspended_at	The date this line of service was suspended with the carrier. A suspended line still has service, but cannot be used until it is unsuspended			STR
label	The label stored by the carrier for the line of service			STR
created_at	Date created			DATE
updated_at	The date of the last update on the line			DATE
plan_id	ID of the mobile carrier plan			INT
cost_center	The business's cost center of the line assigned to in the portal			STR
carrier_id	Carrier Account Number			INT
ref_device_id	The model of device assigned to this line			INT
sim	The unique serial number for the ICCID/SIM Card for the wireless device on this line			INT
contract_start_date	The effective date that the line of service's contract began			DATE
liability	The entity who the device belongs to (corporate-owned or personally-owned)			STR
no_change	If true, the line should not be canceled or modified			BOOLEAN
country_id	Country of where the service is being activated			INT
description	Description of the device on that line			STR
international_number	The phone number for the international line of service			STR
number	The phone number for the line of service			STR
activities
id	Business associated with line			INT
created_at	The date time the activity was created			DATE
created_by_id	The person who submitted this activity			DATE
line_id	The ID of the line of service for which the request is being made.			INT
completed_at	When this activity was completed			DATE
shipping_address_id	Shipping Address			STR
order_number	The order number from the company who is fulfilling and shipping the order			STR
carrier_account_id	The carrier account the new line on this activity will be added to			INT
preferred_area_code	The preferred area code for the line on this activity			STR
ref_device_id	The ref device associated with the activity			INT
tracking_number	The tracking number of the courier who is delivering shipments for this activity			STR
preferred_calling_prefix	The preferred calling prefix for the line on this activity			STR
state	The current status of this activity			STR
business_id	The ID of the business the device belongs to			INT
courier	Shipper			STR
new_sim	New ICCID/SIM Card for the wireless device on this line			STR
assigned_to_id	Account Specialist			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
comment	Comment			STR
return_date	Return Date			DATE
pick_up_date	Departure Data			DATE
warranty	Warranty			BOOLEAN
plan_id	ID of the mobile carrier plan			INT
carrier_id	ID of the mobile carrier			INT
activity_type_id	The type of request submitted			INT
new_imei	The unique serial number for the wireless device on this line, often found in the device's settings menu or printed on the device itself			STR
sleep_until	If set, this activity will be dormant until the sleep until date			DATE
label	The label stored by the carrier for the line of service			STR
parent_activity_id	The parent activity of the activity			INT
lockbox_token	The token that corresponds to the credit card being used in Lockbox			STR
device_id	The ID for the device for this line			INT
replacement_ref_device_id	The ref device that replaces the current ref device			INT
existing_person_id	ID of existing person			STR
replacement_plan_id	The plan that replaces the current plan			INT
existing_plan_id	The current plan of the line to be modified by this activity			INT
lost_stolen	Was this device marked as lost or stolen			BOOLEAN
currency	The three letter currency code of the currency used for the activity			STR
plan_cost_cents	The cost of the plan selected on this activity in cents			INT
device_cost_cents	The cost of the device selected on this activity in cents			INT
approved_at	The time when this activity was approved including time to verify policy agreement			DATE
shipping_method	The shipping method used by the activity			STR
triggered_by_activity_id	Triggered by activity			INT
rpa_attempted	Indicates if RPA has been attempted			STR
original_carrier_account_id	The original carrier account			INT
group_location_id	Group Location			LocationType
is_unsuspend	Line is unsuspended			BOOLEAN
activity_details
name	Activity Name			STR
url	URL to the activity			STR
field_data	Field Data			STR
custom_fields	Custom Fields			STR
parent_account	The ID of the parent account the carrier account belongs to			INT
cycle_end_day	The day of the month when the billing cycle ends			INT
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/lines/business\_lines (Show all the lines for the requester's business) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
active_eq	Display only active lines for the business.	FALSE		BOOLEAN
updated_at_gt	Date by which to filter devices updated after (e.g. '2014-06-07')	FALSE		STR
updated_at_lt	Date by which to filter devices updated before (e.g. '2014-06-07')	FALSE		STR
updated_at_gte	Date by which to filter devices updated after or on (e.g. '2014-06-07')	FALSE		STR
updated_at_lte	Date by which to filter devices updated before (e.g. '2014-06-07')	FALSE		STR
per_page	Limit the number of elements on the response.	FALSE	default: 100	INT
page	The page number of the paginated collection.	FALSE		INT
200 RESPONSE
id	Business associated with line			INT
created_at	The date time the activity was created			DATE
created_by_id	The person who submitted this activity			DATE
line_id	The ID of the line of service for which the request is being made.			INT
completed_at	When this activity was completed			DATE
shipping_address_id	Shipping Address			STR
carrier_account_id	The carrier account the new line on this activity will be added to			INT
preferreed_area_code	The preferred area code for the line on this activity			STR
ref_device_id	The ref device associated with the activity			INT
preferred_calling_prefix	The preferred calling prefix for the line on this activity			STR
state	The current status of this activity			STR
business_id	The ID of the business the device belongs to			INT
new_sim	New ICCID/SIM Card for the wireless device on this line			STR
assigned_to_id	Account Specialist			STR
created_at	Date created			DATE
updated_at	Date updated			DATE
comment	Comment			STR
return_date	Return Date			DATE
pick_up_date	Departure Data			DATE
warranty	Warranty			BOOLEAN
plan_id	ID of the mobile carrier plan			INT
carrier_id	ID of the mobile carrier			INT
activity_type_id	The type of request submitted			INT
parent_activity_id	The parent activity of the activity			INT
lockbox_token	The token that corresponds to the credit card being used in Lockbox			STR
device_id	The ID for the device for this line			INT
replacement_ref_device_id	The ref device that replaces the current ref device			INT
existing_ref_device_id	Existing Device Model			INT
replacement_person_id	Replacement person			INT
existing_person_id	ID of existing person			STR
replacement_plan_id	The plan that replaces the current plan			INT
existing_plan_id	The current plan of the line to be modified by this activity			INT
currency	The three letter currency code of the currency used for the activity			STR
plan_cost_cents	The cost of the plan selected on this activity in cents			INT
device_cost_cents	The cost of the device selected on this activity in cents			INT
shipping_method	The shipping method used by the activity			STR
is_unsuspended	Not suspended			STR
activity_details
name	Activity Name			STR
url	URL to the activity			STR
field_data	Field Data			STR

/lines/{ID} (Display only active lines for the business) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	Display only active lines for the business.	TRUE	STR
details	Details should be true in order to receive more detailed information about a specific line. When this parameter is set to true it will include line billing information.	FALSE	STR
200 RESPONSE
id	The portal unique identifier for this line		INT
active	Indicates if the carrier account is active		BOOLEAN
business_id	Business associated with the line		DATE
contract_ends	The date when the line of service can be canceled with no penalties from the carrier		STR
carrier_account_id	Carrier Account Number		STR
person_id	The ID of the person this line is assigned to in the portal		INT
suspended_at	The date this line of service was suspended with the carrier. A suspended line still has service, but cannot be used until it is unsuspended		STR
label	The label stored by the carrier for the line of service		STR
created_at	Date created		DATE
updated_at	The date of the last update on the line		DATE
plan_id	ID of the mobile carrier plan		INT
cost_center	The business's cost center of the line assigned to in the portal		STR
carrier_id	Carrier Account Number		INT
ref_device_id	The model of device assigned to this line		INT
sim	The unique serial number for the ICCID/SIM Card for the wireless device on this line		INT
contract_start_date	The effective date that the line of service's contract began		DATE
liability	The entity who the device belongs to (corporate-owned or personally-owned)		STR
no_change	If true, the line should not be canceled or modified		BOOLEAN
country_id	Country of where the service is being activated		INT
description	Description of the device on that line		STR
international_number	The phone number for the international line of service		STR
number	The phone number for the line of service		STR
activities
id	Business associated with line		INT
created_at	The date time the activity was created		DATE
created_by_id	The person who submitted this activity		DATE
line_id	The ID of the line of service for which the request is being made.		INT
completed_at	When this activity was completed		DATE
shipping_address_id	Shipping Address		STR
order_number	The order number from the company who is fulfilling and shipping the order		STR
carrier_account_id	The carrier account the new line on this activity will be added to		INT
preferred_area_code	The preferred area code for the line on this activity		STR
ref_device_id	The ref device associated with the activity		INT
tracking_number	The tracking number of the courier who is delivering shipments for this activity		STR
preferred_calling_prefix	The preferred calling prefix for the line on this activity		STR
state	The current status of this activity		STR
business_id	The ID of the business the device belongs to		INT
courier	Shipper		STR
new_sim	New ICCID/SIM Card for the wireless device on this line		STR
assigned_to_id	Account Specialist		INT
created_at	Date created		DATE
updated_at	Date updated		DATE
comment	Comment		STR
return_date	Return Date		DATE
pick_up_date	Departure Data		DATE
warranty	Warranty		BOOLEAN
plan_id	ID of the mobile carrier plan		INT
carrier_id	ID of the mobile carrier		INT
activity_type_id	The type of request submitted		INT
new_imei	The unique serial number for the wireless device on this line, often found in the device's settings menu or printed on the device itself		STR
sleep_until	If set, this activity will be dormant until the sleep until date		DATE
label	The label stored by the carrier for the line of service		STR
parent_activity_id	The parent activity of the activity		INT
lockbox_token	The token that corresponds to the credit card being used in Lockbox		STR
device_id	The ID for the device for this line		INT
replacement_ref_device_id	The ref device that replaces the current ref device		INT
existing_person_id	ID of existing person		PersonType
replacement_plan_id	The plan that replaces the current plan		INT
existing_plan_id	The current plan of the line to be modified by this activity		INT
lost_stolen	Was this device marked as lost or stolen		BOOLEAN
currency	The three letter currency code of the currency used for the activity		STR
plan_cost_cents	The cost of the plan selected on this activity in cents		INT
device_cost_cents	The cost of the device selected on this activity in cents		INT
approved_at	The time when this activity was approved including time to verify policy agreement		DATE
shipping_method	The shipping method used by the activity		STR
triggered_by_activity_id	Triggered by activity		INT
rpa_attempted	Indicates if RPA has been attempted		STR
original_carrier_account_id	The original carrier account		INT
group_location_id	Group Location		LocationType
is_unsuspend	Line is unsuspended		BOOLEAN
activity_details
name	Activity Name		STR
url	URL to the activity		STR
field_data	Field Data		STR
custom_fields	Custom Fields		STR
parent_account	The ID of the parent account the carrier account belongs to		INT
cycle_end_day	The day of the month when the billing cycle ends		INT
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/lines/search (Search for line by number) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE
number	Phone number of the line.	TRUE	STR
international_number	The phone number for the international line of service	FALSE	STR
per_page	Number of items listed on each page
pages	Number of pages in total

/people (All people, filtered by the current business (current\_business is determined by subdomain)) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
200 RESPONSE
id	The unique identifier for the employee			INT
name_last	Employee last name			STR
name_first	Employee first name			STR
name_middle	Employee middle name			STR
email	Employee email			STR
login	Employee login			STR
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.			STR
group_name	Name of group			STR
group_id	ID number of the group			INT
created_at	Date created			DATE
updated_at	The date of the last update on the line			DATE
devices
id	Business associated with the device			INT
line_id	The ID of the line of service for which the request is being made.			INT
ref_device_id	The ref device associated with the activity			INT
business_id	The ID of the business the device belongs to			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
managed	Indicates if the carrier account is managed			STR
full_device_profile	Full device profile			STR
lines
id	The portal unique identifier for this line			INT
active	Indicates if the carrier account is active			BOOLEAN
business_id	The ID of the business the device belongs to			INT
international_number	The phone number for the international line of service			STR
number	Phone number of the line.			STR
carrier_account_id	Carrier Account Number			STR
person_id	The ID of the person this line is assigned to in the portal			INT
label	The label stored by the carrier for the line of service			STR
created_at	Date created			DATE
updated_at	The date of the last update on the line			DATE
plan_id	ID of the mobile carrier plan			INT
cost_center	The business's cost center the line is assigned to in the portal			STR
carrier_id	Carrier Account Number			INT
ref_device_id	The ref device associated with the activity			INT
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/people\_find\_one (Search for one Person. At least one of the parameters must be provided. "employee\_id" is the preferred parameter as a person record will be created if no person record can be found but the employee\_id can be found in the employee import) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUE TYPE	NOTES
employee_id	The employee id of the person	TRUE	STR	only one of email, login, and employee_id is needed. If email is passed it will be used, if email is not passed we will look for login next, and if login is not there we look for employee_id
email	Employee email	TRUE	STR
login	Employee login	TRUE	STR

/people/{ID} (Find one person) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
id	one person, filtered by the current business	TRUE		STR

/program\_membership (All program memberships, filtered by the current business (current\_business is determined by subdomain). A program member may be a person, a line or a device. The enrollee is always a person) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
enrollee_id	The person ID of the program enrollee	FALSE		INT
member_id	The person, line or device ID of the program member	FALSE		INT
member_type	The program member type. If present, allowed values are "Device", "Line", or "Person"	FALSE		STR
200 RESPONSE
id	Unique identifier for the membership			INT
member_id	The person, line or device ID of the program member			INT
member_type	The program member type. If present, allowed values are "Device", "Line", or "Person"			STR
program_id	The identifier of the program to which you are adding a member			INT
joined_at	Date and time joined			DATE
left_at	Date and time left			DATE
enrollee_id	The person ID of the program enrollee			INT
bundle_id	The identifier of the associated bundle (when applicable)			STR
phone_number	Phone number of the member			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/ref\_devices (In Tangoe Mobile, a RefDevice is a specific kind of Device (phone/aircard/tablet/etc.) that a carrier offers. We may have the same device model listed once per carrier. See also: BusinessRefDevice) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	id number of the ref_device	FALSE	INT
200 RESPONSE
id	id number of the ref_device		INT
name	Device full name		STR
description	Full description of device		STR
image_file_name	Name of image file of the device		STR
sku	The generic SKU of the ref device		STR
color	Color of device		STR
platform	The platform the ref device uses		STR
product_category	The type of device (ie. phone, tablet, etc.)		STR
manufacturer	Manufacturer of the device		STR
size	The storage size of the ref device		STR
carrier_name	Name of the carrier for this device		STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
page	Number of pages in total

/report\_exports (A list of generated reports, scoped by the current user) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response per_page	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
200 RESPONSE
id	unique id number of the reports			INT
label	The label stored by the carrier for the line of service			STR
file_file_name	The name of the file attached to the report export			STR
file_file_size	The size of the file attached to the report export			INT
file_content_type	The content type of the file attached to the report export			STR
type	The type of the report export			STR
token	The token of the report export			STR
product_category	The type of device (ie. phone, tablet, etc.)			STR
manufacturer	Manufacturer of the device			STR
size	The storage size of the ref device			INT
carrier_name	Name of the carrier for this device			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
page	Number of pages in total

/support\_request (A list of support requests) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response.	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
created_at_gt	Date by which to filter Support Requests created after (e.g. '2014-06-07')	FALSE		DATE
created_at_lt	Date by which to filter Support Requests created before (e.g. '2014-06-07')	FALSE		DATE
created_at_gte	Date by which to filter Support Requests created after or on (e.g. '2014-06-07')	FALSE		DATE
created_at_lte	Date by which to filter Support Requests created before or on (e.g. '2014-06-07')	FALSE		DATE
updated_at_gt	Date by which to filter Support Requests updated after (e.g. '2014-06-07')	FALSE		DATE
updated_at_lt	Date by which to filter Support Requests updated before (e.g. '2014-06-07')	FALSE		DATE
updated_at_gte	Date by which to filter Support Requests updated after or on (e.g. '2014-06-07')	FALSE		DATE
updated_at_lte	Date by which to filter Support Requests updated before or on (e.g. '2014-06-07')	FALSE		DATE
state_eq	The current state by which to filter Support Requests	FALSE		STR
200 RESPONSE
id	unique id number of the support request			INT
request_type	Type of request			STR
request_name	The name of the person making the request			STR
request_number	The phone number of the person making the request. It is possible for number_request_is_about and to be the same number as the requestor_number			STR
number_request_is_about	The phone number associated with the device that a support request is being made for			STR
on_behalf_of_id	Person ID of the user for which the request is being made			STR
assigned_to_id	The account specialist assigned to process this activity.			INT
line_id	The Line ID of the line of service for which the request is being made			INT
resolved	Triggered when a call is resolved			STR
device_type	The type of device the call is about			INT
state	The current status of this activity			STR
external_source_id	Represents the correlation ID of an external system			INT
interaction_thread	The interaction thread that belongs to the support request			STR
token	The token of the Interaction Thread			STR
interactions
id	Unique id number of the interaction			INT
text	The text of the interaction			STR
created_at	Date created at			DATE
person
id	Unique id of person			INT
name_last	Last name of person			STR
name_first	First name of person			STR
name_middle	Middle name of person			STR
email	Email of person			STR
login	Login of person			STR
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.			STR
created_at	Date created at			DATE
updated_at	Date updated at			DATE
requestor
id	Unique id of person			INT
name_last	Last name of person			STR
name_first	First name of person			STR
name_middle	Middle name of person			STR
email	Email of person			STR
login	Login of person			STR
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.			STR
created_at	Date created at			DATE
updated_at	Date updated at			DATE
assigned_to
id	Unique id of person			INT
name_last	Last name of person			STR
name_first	First name of person			STR
name_middle	Middle name of person			STR
email	Email of person			STR
login	Login of person			STR
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.			STR
created_at	Date created at			DATE
updated_at	Date updated at			DATE
active	Indicates if the person is active			BOOLEAN
on_behalf_of
id	Unique id of person on behalf of			INT
name_last	Last name of person			STR
name_first	First name of person			STR
name_middle	Middle name of person			STR
email	Email of person			STR
login	Login of person			STR
employee_id	The employee_id of the Person the device is for; either person_id or employee_id is required.			STR
created_at	Date created at			DATE
updated_at	Date updated at			DATE
line
id	Unique identifier of the line			INT
active	Indicates if the line is active			STR
business_id	The business that the line is associated with			INT
international_number	The phone number for the international line of service			STR
number	The number the line is associated with			STR
carrier_account_id	The carrier account number			INT
person_id	The ID of the person this line is assigned to in the portal			INT
created_at	Date created			DATE
updated_at	Date updated			DATE
plan_id	ID of the mobile carrier plan			INT
cost_center	The business's cost center the line is assigned to in the portal			STR
carrier_id	Carrier Account Number			INT
ref_devcie_id	The ref device associated with this line			INT
description	Description of this line			STR
attachments
id	Unique Identifier of this attachement			INT
created_at	Date created			DATE
file_name	Name of the file for this attachement			STR
file_type	Type of file			STR
download_url	URL to download attachment			STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/support\_request (Create a support request) - POST

ATTRIBUTE NAME	DESCRIPTION	REQUIRED	VALUE TYPE
request_type	Supported values are not static. See the support_types endpoint. request_type and support_types are the same thing by different names for legacy reasons	TRUE	STR
requestor_name	The name of the person making the request.	TRUE	STR
text	Text describing the nature of the support request.	TRUE	STR
device_type	A description of the device that may be related to the request.	TRUE	STR
line_number	The phone number of the line of service for which the request is being made.	TRUE	STR
line_id	The ID of the line of service for which the request is being made.	TRUE	INT
on_behalf_of_id	Person ID of the user for which the request is being made	TRUE	INT
number_request_is_about	The phone number associated with the device that a support request is being made for.	TRUE	STR
requestor_number	The phone number of the person making the request. It is possible for number_request_is_about and to be the same number as the requestor_number.	TRUE	STR
requestor_id	Person ID of the user making the request	TRUE	INT
requestor_employee_id	Employee ID of the user making the request	TRUE	STR
external_source_id	An identifier that links this request to an external ticket, to be used when a request is created through a third-party source.	TRUE	STR
200 RESPONSE
id	unique id number of the support request		INT
request_type	Type of request		STR
requestor_name	The name of the person making the request		STR
requestor_number	The phone number of the person making the request. It is possible for number_request_is_about and to be the same number as the requestor_number		STR
number_request_is_about	The phone number associated with the device that a support request is being made for		STR
on_behalf_of_id	Person ID of the user for which the request is being made		STR
assigned_to_id	The account specialist assigned to process this activity.		INT
line_id	The Line ID of the line of service for which the request is being made		INT
resolved	Triggered when a call is resolved		STR
device_type	The type of device the call is about		INT
state	The current status of this activity		STR
external_source_id	Represents the correlation ID of an external system		STR
interaction_thread	The interaction thread that belongs to the support request		STR
token	The token of the Interaction Thread		STR

/support\_request/{ID} (Singal support request) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
id	ID for the support request	TRUE		STR

/support\_request{ID} (Update a support request) - PUT

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
id	ID for the support request	TRUE	STR
ATTRIBUTE NAME
state	supported values are reopen, await_customer_response, external_queue, close, and cancel.	TRUE	STR

/support\_request/{ID}/assign (Assign a support request) - PUT

URI PARAMETER	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE	NOTES
id	ID for the support request	TRUE		STR
assigned_to_id	The identifier of the person the support request is being assigned to.	TRUE		STR

/support\_types (A list of support types. These are scoped to the current business. Each business has their own set of support types) - GET

URI PARAMETER	DESCRIPTION	REQUIRED	VALUE TYPE
per_page	Number of items listed on each page	FALSE
pages	Number of pages in total	FALSE
200 RESPONSE
id	unique id number of the support type		INT
active	Is support type active		BOOLEAN
long_name	Description of support type		STR
count	Number of total items
pagination	Sequence of numbers assigned to pages
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

/testing/ok (A way to test authentication or availability) - GET

QUERY PARAMETERS	DESCRIPTION	REQUIRED	VALUES	VALUE TYPE
per_page	Limit the number of elements on the response	FALSE	default: 100	INT (integer)
page	Shows the number of pages	FALSE		INT
200 RESPONSE
text	Test description			STR
count	Number of total items
pagination
current	Shows the current page number
per_page	Number of items listed on each page
count	Number of total items
pages	Number of pages in total

Attribute Mapping

/activities (Show a list of Activities) - GET

/activities/preview\_price (This takes the same inputs as the "Create a new Activity" endpoint but returns One Time and Recurring costs instead) - POST

/activities/validate\_price (This takes the same inputs as the "Create a new Activity" endpoint and only returns validation information) - POST

/activities/{ID} (Show a single activity) - GET

/accessories (Show a list of configured accessories for a business) - GET

/accessories/{ID} (The ID of a single accessory) - GET

/approvals (Show all visible approvals for the current person) - GET

/approvals/{ID}/approve (Approve an Approval) - POST

/approvals/{ID}/deny (Deny an Approval) - POST

/approvals/{ID} (Show a single Approval) - GET

/bulletins (Show all of the visible bulletins for the current person) - GET

/bulletins/{ID}/dismiss (Dismiss a bulletin) - PATCH

/business\_features (In Tangoe Mobile, a BusinessFeature is a Feature (messaging, data, etc.) associated with a Business filtered by the parameters provided) - GET

/business\_features /features\_to\_add (Dismiss a bulletin) - GET

/business\_plan (In Tangoe Mobile, a BusinessPlan is a Carrier's Plan associated with a Business) - GET

/business\_ref\_devices (A specific kind of Device list (phone/aircard/tablet/etc.) associated with a Business) - GET

/business\_ref\_devices/{id} (Show a single BusinessRefDevice, found by its id) - GET

/business\_ref\_devices/{ref\_device\_id}/show\_by\_ref\_device\_id (Show a single BusinessRefDevice, found by its ref\_device\_id) - GET

/business\_ref\_devices/catalog (Show the entire business ref device catalog for a business.) - GET

/calls (Calls capture the interaction between a support specialist and a live customer) - GET

/calls/{ID} (Calls capture the interaction between a support specialist and a live customer) - GET

/carriers (A list of carriers, optionally filtered by person\_id or employee\_id) - GET

/devices (Show all the devices for the requester's business) - GET

/devices (Create a device) - PUSH

/devices/business\_devices (Show all the devices for the requester's business) - GET

/devices/search (Search for a device by device identifiers) - GET

/devices/{ID} (Search for a device by device identifiers) - GET

/features (Features will be filtered by only one parameter, must provide one parameter) - GET

/interactions (Create an interaction) - POST

/lines (Show all the lines for a person and the line's associated activities) - GET

/lines/business\_lines (Show all the lines for the requester's business) - GET

/lines/{ID} (Display only active lines for the business) - GET

/lines/search (Search for line by number) - GET

/people (All people, filtered by the current business (current\_business is determined by subdomain)) - GET

/people\_find\_one (Search for one Person. At least one of the parameters must be provided. "employee\_id" is the preferred parameter as a person record will be created if no person record can be found but the employee\_id can be found in the employee import) - GET

/people/{ID} (Find one person) - GET

/program\_membership (All program memberships, filtered by the current business (current\_business is determined by subdomain). A program member may be a person, a line or a device. The enrollee is always a person) - GET

/ref\_devices (In Tangoe Mobile, a RefDevice is a specific kind of Device (phone/aircard/tablet/etc.) that a carrier offers. We may have the same device model listed once per carrier. See also: BusinessRefDevice) - GET

/report\_exports (A list of generated reports, scoped by the current user) - GET

/support\_request (A list of support requests) - GET

/support\_request (Create a support request) - POST

/support\_request/{ID} (Singal support request) - GET

/support\_request{ID} (Update a support request) - PUT

/support\_request/{ID}/assign (Assign a support request) - PUT

/support\_types (A list of support types. These are scoped to the current business. Each business has their own set of support types) - GET

/testing/ok (A way to test authentication or availability) - GET

Reviews